<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AbstractProcessingInstruction xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/dom4j/tree/AbstractProcessingInstruction.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="3" href="#3">3</a>   <em class="comment"> *</em>
<a name="4" href="#4">4</a>   <em class="comment"> * This software is open source.</em>
<a name="5" href="#5">5</a>   <em class="comment"> * See the bottom of this file for the licence.</em>
<a name="6" href="#6">6</a>   <em class="comment"> */</em>
<a name="7" href="#7">7</a>   
<a name="8" href="#8">8</a>   <strong>package</strong> <a href="../../../org/dom4j/tree/package-summary.html">org.dom4j.tree</a>;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <strong>import</strong> java.io.IOException;
<a name="11" href="#11">11</a>  <strong>import</strong> java.io.Writer;
<a name="12" href="#12">12</a>  <strong>import</strong> java.util.HashMap;
<a name="13" href="#13">13</a>  <strong>import</strong> java.util.Iterator;
<a name="14" href="#14">14</a>  <strong>import</strong> java.util.Map;
<a name="15" href="#15">15</a>  <strong>import</strong> java.util.StringTokenizer;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> org.dom4j.Element;
<a name="18" href="#18">18</a>  <strong>import</strong> org.dom4j.ProcessingInstruction;
<a name="19" href="#19">19</a>  <strong>import</strong> org.dom4j.Visitor;
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <em>/**<em>*</em></em>
<a name="22" href="#22">22</a>  <em> * &lt;p></em>
<a name="23" href="#23">23</a>  <em> * &lt;code>AbstractProcessingInstruction&lt;/code> is an abstract base class for</em>
<a name="24" href="#24">24</a>  <em> * tree implementors to use for implementation inheritence.</em>
<a name="25" href="#25">25</a>  <em> * &lt;/p></em>
<a name="26" href="#26">26</a>  <em> * </em>
<a name="27" href="#27">27</a>  <em> * @author &lt;a href="<a href="mailto:james.strachan@metastuff.com" target="alexandria_uri">mailto:james.strachan@metastuff.com</a>">James Strachan &lt;/a></em>
<a name="28" href="#28">28</a>  <em> * @version $Revision: 1.17 $</em>
<a name="29" href="#29">29</a>  <em> */</em>
<a name="30" href="#30">30</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../org/dom4j/tree/AbstractProcessingInstruction.html">AbstractProcessingInstruction</a> <strong>extends</strong> <a href="../../../org/dom4j/tree/AbstractNode.html">AbstractNode</a>
<a name="31" href="#31">31</a>          implements <a href="../../../org/dom4j/ProcessingInstruction.html">ProcessingInstruction</a> {
<a name="32" href="#32">32</a>      <strong>public</strong> <a href="../../../org/dom4j/tree/AbstractProcessingInstruction.html">AbstractProcessingInstruction</a>() {
<a name="33" href="#33">33</a>      }
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>      <strong>public</strong> <strong>short</strong> getNodeType() {
<a name="36" href="#36">36</a>          <strong>return</strong> PROCESSING_INSTRUCTION_NODE;
<a name="37" href="#37">37</a>      }
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>      <strong>public</strong> String getPath(<a href="../../../org/dom4j/Element.html">Element</a> context) {
<a name="40" href="#40">40</a>          <a href="../../../org/dom4j/Element.html">Element</a> parent = getParent();
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>          <strong>return</strong> ((parent != <strong>null</strong>) &amp;&amp; (parent != context)) ? (parent
<a name="43" href="#43">43</a>                  .getPath(context) + <span class="string">"/processing-instruction()"</span>)
<a name="44" href="#44">44</a>                  : <span class="string">"processing-instruction()"</span>;
<a name="45" href="#45">45</a>      }
<a name="46" href="#46">46</a>  
<a name="47" href="#47">47</a>      <strong>public</strong> String getUniquePath(<a href="../../../org/dom4j/Element.html">Element</a> context) {
<a name="48" href="#48">48</a>          <a href="../../../org/dom4j/Element.html">Element</a> parent = getParent();
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>          <strong>return</strong> ((parent != <strong>null</strong>) &amp;&amp; (parent != context)) ? (parent
<a name="51" href="#51">51</a>                  .getUniquePath(context) + <span class="string">"/processing-instruction()"</span>)
<a name="52" href="#52">52</a>                  : <span class="string">"processing-instruction()"</span>;
<a name="53" href="#53">53</a>      }
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <strong>public</strong> String toString() {
<a name="56" href="#56">56</a>          <strong>return</strong> <strong>super</strong>.toString() + <span class="string">" [ProcessingInstruction: &amp;"</span> + getName()
<a name="57" href="#57">57</a>                  + <span class="string">";]"</span>;
<a name="58" href="#58">58</a>      }
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <strong>public</strong> String asXML() {
<a name="61" href="#61">61</a>          <strong>return</strong> <span class="string">"&lt;?"</span> + getName() + <span class="string">" "</span> + getText() + <span class="string">"?>"</span>;
<a name="62" href="#62">62</a>      }
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>      <strong>public</strong> <strong>void</strong> write(Writer writer) throws IOException {
<a name="65" href="#65">65</a>          writer.write(<span class="string">"&lt;?"</span>);
<a name="66" href="#66">66</a>          writer.write(getName());
<a name="67" href="#67">67</a>          writer.write(<span class="string">" "</span>);
<a name="68" href="#68">68</a>          writer.write(getText());
<a name="69" href="#69">69</a>          writer.write(<span class="string">"?>"</span>);
<a name="70" href="#70">70</a>      }
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>      <strong>public</strong> <strong>void</strong> accept(<a href="../../../org/dom4j/Visitor.html">Visitor</a> visitor) {
<a name="73" href="#73">73</a>          visitor.visit(<strong>this</strong>);
<a name="74" href="#74">74</a>      }
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <strong>public</strong> <strong>void</strong> setValue(String name, String value) {
<a name="77" href="#77">77</a>          <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"This PI is read-only and "</span>
<a name="78" href="#78">78</a>                  + <span class="string">"cannot be modified"</span>);
<a name="79" href="#79">79</a>      }
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>      <strong>public</strong> <strong>void</strong> setValues(Map data) {
<a name="82" href="#82">82</a>          <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"This PI is read-only and "</span>
<a name="83" href="#83">83</a>                  + <span class="string">"cannot be modified"</span>);
<a name="84" href="#84">84</a>      }
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <strong>public</strong> String getName() {
<a name="87" href="#87">87</a>          <strong>return</strong> getTarget();
<a name="88" href="#88">88</a>      }
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>      <strong>public</strong> <strong>void</strong> setName(String name) {
<a name="91" href="#91">91</a>          setTarget(name);
<a name="92" href="#92">92</a>      }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <strong>public</strong> <strong>boolean</strong> removeValue(String name) {
<a name="95" href="#95">95</a>          <strong>return</strong> false;
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <em class="comment">// Helper methods</em>
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em>/**<em>*</em></em>
<a name="101" href="#101">101</a> <em>     * &lt;p></em>
<a name="102" href="#102">102</a> <em>     * This will convert the Map to a string representation.</em>
<a name="103" href="#103">103</a> <em>     * &lt;/p></em>
<a name="104" href="#104">104</a> <em>     * </em>
<a name="105" href="#105">105</a> <em>     * @param values</em>
<a name="106" href="#106">106</a> <em>     *            is a &lt;code>Map&lt;/code> of PI data to convert</em>
<a name="107" href="#107">107</a> <em>     * </em>
<a name="108" href="#108">108</a> <em>     * @return DOCUMENT ME!</em>
<a name="109" href="#109">109</a> <em>     */</em>
<a name="110" href="#110">110</a>     <strong>protected</strong> String toString(Map values) {
<a name="111" href="#111">111</a>         StringBuffer buffer = <strong>new</strong> StringBuffer();
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>         <strong>for</strong> (Iterator iter = values.entrySet().iterator(); iter.hasNext();) {
<a name="114" href="#114">114</a>             Map.Entry entry = (Map.Entry) iter.next();
<a name="115" href="#115">115</a>             String name = (String) entry.getKey();
<a name="116" href="#116">116</a>             String value = (String) entry.getValue();
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>             buffer.append(name);
<a name="119" href="#119">119</a>             buffer.append(<span class="string">"=\&quot;"</span>);
<a name="120" href="#120">120</a>             buffer.append(value);
<a name="121" href="#121">121</a>             buffer.append(<span class="string">"\&quot; "</span>);
<a name="122" href="#122">122</a>         }
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>         <em class="comment">// remove the last space</em>
<a name="125" href="#125">125</a>         buffer.setLength(buffer.length() - 1);
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>         <strong>return</strong> buffer.toString();
<a name="128" href="#128">128</a>     }
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>     <em>/**<em>*</em></em>
<a name="131" href="#131">131</a> <em>     * &lt;p></em>
<a name="132" href="#132">132</a> <em>     * Parses the raw data of PI as a &lt;code>Map&lt;/code>.</em>
<a name="133" href="#133">133</a> <em>     * &lt;/p></em>
<a name="134" href="#134">134</a> <em>     * </em>
<a name="135" href="#135">135</a> <em>     * @param text</em>
<a name="136" href="#136">136</a> <em>     *            &lt;code>String&lt;/code> PI data to parse</em>
<a name="137" href="#137">137</a> <em>     * </em>
<a name="138" href="#138">138</a> <em>     * @return DOCUMENT ME!</em>
<a name="139" href="#139">139</a> <em>     */</em>
<a name="140" href="#140">140</a>     <strong>protected</strong> Map parseValues(String text) {
<a name="141" href="#141">141</a>         Map data = <strong>new</strong> HashMap();
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>         StringTokenizer s = <strong>new</strong> StringTokenizer(text, <span class="string">" =\'\&quot;"</span>, <strong>true</strong>);
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>         <strong>while</strong> (s.hasMoreTokens()) {
<a name="146" href="#146">146</a>             String name = getName(s);
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>             <strong>if</strong> (s.hasMoreTokens()) {
<a name="149" href="#149">149</a>                 String value = getValue(s);
<a name="150" href="#150">150</a>                 data.put(name, value);
<a name="151" href="#151">151</a>             }
<a name="152" href="#152">152</a>         }
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>         <strong>return</strong> data;
<a name="155" href="#155">155</a>     }
<a name="156" href="#156">156</a> 
<a name="157" href="#157">157</a>     <strong>private</strong> String getName(StringTokenizer tokenizer) {
<a name="158" href="#158">158</a>         String token = tokenizer.nextToken();
<a name="159" href="#159">159</a>         StringBuffer name = <strong>new</strong> StringBuffer(token);
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>         <strong>while</strong> (tokenizer.hasMoreTokens()) {
<a name="162" href="#162">162</a>             token = tokenizer.nextToken();
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>             <strong>if</strong> (!token.equals(<span class="string">"="</span>)) {
<a name="165" href="#165">165</a>                 name.append(token);
<a name="166" href="#166">166</a>             } <strong>else</strong> {
<a name="167" href="#167">167</a>                 <strong>break</strong>;
<a name="168" href="#168">168</a>             }
<a name="169" href="#169">169</a>         }
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>         <strong>return</strong> name.toString().trim();
<a name="172" href="#172">172</a>     }
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>     <strong>private</strong> String getValue(StringTokenizer tokenizer) {
<a name="175" href="#175">175</a>         String token = tokenizer.nextToken();
<a name="176" href="#176">176</a>         StringBuffer value = <strong>new</strong> StringBuffer();
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>         <em class="comment">/*<em class="comment"> get the quote */</em></em>
<a name="179" href="#179">179</a>         <strong>while</strong> (tokenizer.hasMoreTokens() &amp;&amp; !token.equals(<span class="string">"\'"</span>)
<a name="180" href="#180">180</a>                 &amp;&amp; !token.equals(<span class="string">"\&quot;"</span>)) {
<a name="181" href="#181">181</a>             token = tokenizer.nextToken();
<a name="182" href="#182">182</a>         }
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>         String quote = token;
<a name="185" href="#185">185</a> 
<a name="186" href="#186">186</a>         <strong>while</strong> (tokenizer.hasMoreTokens()) {
<a name="187" href="#187">187</a>             token = tokenizer.nextToken();
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>             <strong>if</strong> (!quote.equals(token)) {
<a name="190" href="#190">190</a>                 value.append(token);
<a name="191" href="#191">191</a>             } <strong>else</strong> {
<a name="192" href="#192">192</a>                 <strong>break</strong>;
<a name="193" href="#193">193</a>             }
<a name="194" href="#194">194</a>         }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>         <strong>return</strong> value.toString();
<a name="197" href="#197">197</a>     }
<a name="198" href="#198">198</a> }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a> <em class="comment">/*</em>
<a name="201" href="#201">201</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="202" href="#202">202</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="203" href="#203">203</a> <em class="comment"> * following conditions are met:</em>
<a name="204" href="#204">204</a> <em class="comment"> * </em>
<a name="205" href="#205">205</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="206" href="#206">206</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="207" href="#207">207</a> <em class="comment"> * </em>
<a name="208" href="#208">208</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="209" href="#209">209</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="210" href="#210">210</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="211" href="#211">211</a> <em class="comment"> * </em>
<a name="212" href="#212">212</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="213" href="#213">213</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="214" href="#214">214</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="215" href="#215">215</a> <em class="comment"> * </em>
<a name="216" href="#216">216</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="217" href="#217">217</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="218" href="#218">218</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="219" href="#219">219</a> <em class="comment"> * </em>
<a name="220" href="#220">220</a> <em class="comment"> * 5. Due credit should be given to the DOM4J Project - <a href="http://www.dom4j.org" target="alexandria_uri">http://www.dom4j.org</a></em>
<a name="221" href="#221">221</a> <em class="comment"> * </em>
<a name="222" href="#222">222</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="223" href="#223">223</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="224" href="#224">224</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="225" href="#225">225</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="226" href="#226">226</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="227" href="#227">227</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="228" href="#228">228</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="229" href="#229">229</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="230" href="#230">230</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="231" href="#231">231</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="232" href="#232">232</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="233" href="#233">233</a> <em class="comment"> * </em>
<a name="234" href="#234">234</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="235" href="#235">235</a> <em class="comment"> */</em>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

